////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (c) 2010 Leon Coto Rodriguez
//  leoncoto@gmail.com
//  
//  Permission is hereby granted, free of charge, to any person
//  obtaining a copy of this software and associated documentation
//  files (the "Software"), to deal in the Software without
//  restriction, including without limitation the rights to use,
//  copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following
//  conditions:
//  
//   The above copyright notice and this permission notice shall be
//   included in all copies or substantial portions of the Software.
//  
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
//  OTHER DEALINGS IN THE SOFTWARE.
//
////////////////////////////////////////////////////////////////////////////////
package org.flexspeedup.delegate
{
import org.flexspeedup.model.IResultSet;

/**
 * Implementing this interface means a class is capable of handing delagated
 * method calls from a <code>ICollectionEditor</code> view 
 */
public interface ICollectionEditorDelegate
{

    //----------------------------------
    //  firstPage
    //----------------------------------
    /**
     * Fetches the first page in the collection
     */
    function firstPage():void;

    //----------------------------------
    //  nextPage
    //----------------------------------
    /**
     * Fetches the next page in the collection.
     */
    function nextPage():void;

    //----------------------------------
    //  previousPage
    //----------------------------------
    /**
     * Fetches the previous page in the collection
     */
    function previousPage():void;

    //----------------------------------
    //  createItem
    //----------------------------------
    /**
     * Starts the creation process of a new item.
     */
    function createItem():void;

    //----------------------------------
    //  deleteItem
    //----------------------------------
    /**
     * Deletes an item from the collection
     */
    function deleteItem(item:*):void;

    //----------------------------------
    //  save
    //----------------------------------
    /**
     * Saves a new item into the collection
     */
    function saveItem(item:*):void;

    //----------------------------------
    //  publishItem
    //----------------------------------
    /**
     * publish a saved item
     */
    function publishItem(item:*):void;
    
    //----------------------------------
    //  editItem
    //----------------------------------
    /**
     * Marks an item for edition.
     */
    function editItem(item:*):void;

    //----------------------------------
    //  updateModelFromResultSet
    //----------------------------------
    /**
     * Updates the model from an <code>IResultSet<code> instance
     */
    function updateModelFromResultSet(resultSet:IResultSet):void;

    //----------------------------------
    //  updateModelFromArray
    //----------------------------------
    /**
     * Updates the model from an <code>Array<code> instance
     */
    function updateModelFromArray(array:Array):void;
}
}